<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.fileupload.disk;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.File;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.commons.fileupload.FileItem;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.commons.fileupload.FileItemFactory;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.commons.io.FileCleaningTracker;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /**<a name="line.26"></a>
<FONT color="green">027</FONT>     * &lt;p&gt;The default {@link org.apache.commons.fileupload.FileItemFactory}<a name="line.27"></a>
<FONT color="green">028</FONT>     * implementation. This implementation creates<a name="line.28"></a>
<FONT color="green">029</FONT>     * {@link org.apache.commons.fileupload.FileItem} instances which keep their<a name="line.29"></a>
<FONT color="green">030</FONT>     * content either in memory, for smaller items, or in a temporary file on disk,<a name="line.30"></a>
<FONT color="green">031</FONT>     * for larger items. The size threshold, above which content will be stored on<a name="line.31"></a>
<FONT color="green">032</FONT>     * disk, is configurable, as is the directory in which temporary files will be<a name="line.32"></a>
<FONT color="green">033</FONT>     * created.&lt;/p&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;p&gt;If not otherwise configured, the default configuration values are as<a name="line.35"></a>
<FONT color="green">036</FONT>     * follows:<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;ul&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     *   &lt;li&gt;Size threshold is 10KB.&lt;/li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     *   &lt;li&gt;Repository is the system default temp directory, as returned by<a name="line.39"></a>
<FONT color="green">040</FONT>     *       &lt;code&gt;System.getProperty("java.io.tmpdir")&lt;/code&gt;.&lt;/li&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;/ul&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;/p&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     *<a name="line.43"></a>
<FONT color="green">044</FONT>     * &lt;p&gt;Temporary files, which are created for file items, should be<a name="line.44"></a>
<FONT color="green">045</FONT>     * deleted later on. The best way to do this is using a<a name="line.45"></a>
<FONT color="green">046</FONT>     * {@link FileCleaningTracker}, which you can set on the<a name="line.46"></a>
<FONT color="green">047</FONT>     * {@link DiskFileItemFactory}. However, if you do use such a tracker,<a name="line.47"></a>
<FONT color="green">048</FONT>     * then you must consider the following: Temporary files are automatically<a name="line.48"></a>
<FONT color="green">049</FONT>     * deleted as soon as they are no longer needed. (More precisely, when the<a name="line.49"></a>
<FONT color="green">050</FONT>     * corresponding instance of {@link java.io.File} is garbage collected.)<a name="line.50"></a>
<FONT color="green">051</FONT>     * This is done by the so-called reaper thread, which is started<a name="line.51"></a>
<FONT color="green">052</FONT>     * automatically when the class {@link org.apache.commons.io.FileCleaner}<a name="line.52"></a>
<FONT color="green">053</FONT>     * is loaded.<a name="line.53"></a>
<FONT color="green">054</FONT>     * It might make sense to terminate that thread, for example, if<a name="line.54"></a>
<FONT color="green">055</FONT>     * your web application ends. See the section on "Resource cleanup"<a name="line.55"></a>
<FONT color="green">056</FONT>     * in the users guide of commons-fileupload.&lt;/p&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     *<a name="line.57"></a>
<FONT color="green">058</FONT>     * @author &lt;a href="mailto:martinc@apache.org"&gt;Martin Cooper&lt;/a&gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     *<a name="line.59"></a>
<FONT color="green">060</FONT>     * @since FileUpload 1.1<a name="line.60"></a>
<FONT color="green">061</FONT>     *<a name="line.61"></a>
<FONT color="green">062</FONT>     * @version $Id: DiskFileItemFactory.java 735374 2009-01-18 02:18:45Z jochen $<a name="line.62"></a>
<FONT color="green">063</FONT>     */<a name="line.63"></a>
<FONT color="green">064</FONT>    public class DiskFileItemFactory implements FileItemFactory {<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>        // ----------------------------------------------------- Manifest constants<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        /**<a name="line.69"></a>
<FONT color="green">070</FONT>         * The default threshold above which uploads will be stored on disk.<a name="line.70"></a>
<FONT color="green">071</FONT>         */<a name="line.71"></a>
<FONT color="green">072</FONT>        public static final int DEFAULT_SIZE_THRESHOLD = 10240;<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>        // ----------------------------------------------------- Instance Variables<a name="line.75"></a>
<FONT color="green">076</FONT>    <a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>        /**<a name="line.78"></a>
<FONT color="green">079</FONT>         * The directory in which uploaded files will be stored, if stored on disk.<a name="line.79"></a>
<FONT color="green">080</FONT>         */<a name="line.80"></a>
<FONT color="green">081</FONT>        private File repository;<a name="line.81"></a>
<FONT color="green">082</FONT>    <a name="line.82"></a>
<FONT color="green">083</FONT>    <a name="line.83"></a>
<FONT color="green">084</FONT>        /**<a name="line.84"></a>
<FONT color="green">085</FONT>         * The threshold above which uploads will be stored on disk.<a name="line.85"></a>
<FONT color="green">086</FONT>         */<a name="line.86"></a>
<FONT color="green">087</FONT>        private int sizeThreshold = DEFAULT_SIZE_THRESHOLD;<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>        /**<a name="line.90"></a>
<FONT color="green">091</FONT>         * &lt;p&gt;The instance of {@link FileCleaningTracker}, which is responsible<a name="line.91"></a>
<FONT color="green">092</FONT>         * for deleting temporary files.&lt;/p&gt;<a name="line.92"></a>
<FONT color="green">093</FONT>         * &lt;p&gt;May be null, if tracking files is not required.&lt;/p&gt;<a name="line.93"></a>
<FONT color="green">094</FONT>         */<a name="line.94"></a>
<FONT color="green">095</FONT>        private FileCleaningTracker fileCleaningTracker;<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>        // ----------------------------------------------------------- Constructors<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>        /**<a name="line.100"></a>
<FONT color="green">101</FONT>         * Constructs an unconfigured instance of this class. The resulting factory<a name="line.101"></a>
<FONT color="green">102</FONT>         * may be configured by calling the appropriate setter methods.<a name="line.102"></a>
<FONT color="green">103</FONT>         */<a name="line.103"></a>
<FONT color="green">104</FONT>        public DiskFileItemFactory() {<a name="line.104"></a>
<FONT color="green">105</FONT>            this(DEFAULT_SIZE_THRESHOLD, null);<a name="line.105"></a>
<FONT color="green">106</FONT>        }<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>        /**<a name="line.109"></a>
<FONT color="green">110</FONT>         * Constructs a preconfigured instance of this class.<a name="line.110"></a>
<FONT color="green">111</FONT>         *<a name="line.111"></a>
<FONT color="green">112</FONT>         * @param sizeThreshold The threshold, in bytes, below which items will be<a name="line.112"></a>
<FONT color="green">113</FONT>         *                      retained in memory and above which they will be<a name="line.113"></a>
<FONT color="green">114</FONT>         *                      stored as a file.<a name="line.114"></a>
<FONT color="green">115</FONT>         * @param repository    The data repository, which is the directory in<a name="line.115"></a>
<FONT color="green">116</FONT>         *                      which files will be created, should the item size<a name="line.116"></a>
<FONT color="green">117</FONT>         *                      exceed the threshold.<a name="line.117"></a>
<FONT color="green">118</FONT>         */<a name="line.118"></a>
<FONT color="green">119</FONT>        public DiskFileItemFactory(int sizeThreshold, File repository) {<a name="line.119"></a>
<FONT color="green">120</FONT>            this.sizeThreshold = sizeThreshold;<a name="line.120"></a>
<FONT color="green">121</FONT>            this.repository = repository;<a name="line.121"></a>
<FONT color="green">122</FONT>        }<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        // ------------------------------------------------------------- Properties<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>    <a name="line.126"></a>
<FONT color="green">127</FONT>        /**<a name="line.127"></a>
<FONT color="green">128</FONT>         * Returns the directory used to temporarily store files that are larger<a name="line.128"></a>
<FONT color="green">129</FONT>         * than the configured size threshold.<a name="line.129"></a>
<FONT color="green">130</FONT>         *<a name="line.130"></a>
<FONT color="green">131</FONT>         * @return The directory in which temporary files will be located.<a name="line.131"></a>
<FONT color="green">132</FONT>         *<a name="line.132"></a>
<FONT color="green">133</FONT>         * @see #setRepository(java.io.File)<a name="line.133"></a>
<FONT color="green">134</FONT>         *<a name="line.134"></a>
<FONT color="green">135</FONT>         */<a name="line.135"></a>
<FONT color="green">136</FONT>        public File getRepository() {<a name="line.136"></a>
<FONT color="green">137</FONT>            return repository;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>    <a name="line.140"></a>
<FONT color="green">141</FONT>        /**<a name="line.141"></a>
<FONT color="green">142</FONT>         * Sets the directory used to temporarily store files that are larger<a name="line.142"></a>
<FONT color="green">143</FONT>         * than the configured size threshold.<a name="line.143"></a>
<FONT color="green">144</FONT>         *<a name="line.144"></a>
<FONT color="green">145</FONT>         * @param repository The directory in which temporary files will be located.<a name="line.145"></a>
<FONT color="green">146</FONT>         *<a name="line.146"></a>
<FONT color="green">147</FONT>         * @see #getRepository()<a name="line.147"></a>
<FONT color="green">148</FONT>         *<a name="line.148"></a>
<FONT color="green">149</FONT>         */<a name="line.149"></a>
<FONT color="green">150</FONT>        public void setRepository(File repository) {<a name="line.150"></a>
<FONT color="green">151</FONT>            this.repository = repository;<a name="line.151"></a>
<FONT color="green">152</FONT>        }<a name="line.152"></a>
<FONT color="green">153</FONT>    <a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>        /**<a name="line.155"></a>
<FONT color="green">156</FONT>         * Returns the size threshold beyond which files are written directly to<a name="line.156"></a>
<FONT color="green">157</FONT>         * disk. The default value is 10240 bytes.<a name="line.157"></a>
<FONT color="green">158</FONT>         *<a name="line.158"></a>
<FONT color="green">159</FONT>         * @return The size threshold, in bytes.<a name="line.159"></a>
<FONT color="green">160</FONT>         *<a name="line.160"></a>
<FONT color="green">161</FONT>         * @see #setSizeThreshold(int)<a name="line.161"></a>
<FONT color="green">162</FONT>         */<a name="line.162"></a>
<FONT color="green">163</FONT>        public int getSizeThreshold() {<a name="line.163"></a>
<FONT color="green">164</FONT>            return sizeThreshold;<a name="line.164"></a>
<FONT color="green">165</FONT>        }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>        /**<a name="line.168"></a>
<FONT color="green">169</FONT>         * Sets the size threshold beyond which files are written directly to disk.<a name="line.169"></a>
<FONT color="green">170</FONT>         *<a name="line.170"></a>
<FONT color="green">171</FONT>         * @param sizeThreshold The size threshold, in bytes.<a name="line.171"></a>
<FONT color="green">172</FONT>         *<a name="line.172"></a>
<FONT color="green">173</FONT>         * @see #getSizeThreshold()<a name="line.173"></a>
<FONT color="green">174</FONT>         *<a name="line.174"></a>
<FONT color="green">175</FONT>         */<a name="line.175"></a>
<FONT color="green">176</FONT>        public void setSizeThreshold(int sizeThreshold) {<a name="line.176"></a>
<FONT color="green">177</FONT>            this.sizeThreshold = sizeThreshold;<a name="line.177"></a>
<FONT color="green">178</FONT>        }<a name="line.178"></a>
<FONT color="green">179</FONT>    <a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>        // --------------------------------------------------------- Public Methods<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>        /**<a name="line.183"></a>
<FONT color="green">184</FONT>         * Create a new {@link org.apache.commons.fileupload.disk.DiskFileItem}<a name="line.184"></a>
<FONT color="green">185</FONT>         * instance from the supplied parameters and the local factory<a name="line.185"></a>
<FONT color="green">186</FONT>         * configuration.<a name="line.186"></a>
<FONT color="green">187</FONT>         *<a name="line.187"></a>
<FONT color="green">188</FONT>         * @param fieldName   The name of the form field.<a name="line.188"></a>
<FONT color="green">189</FONT>         * @param contentType The content type of the form field.<a name="line.189"></a>
<FONT color="green">190</FONT>         * @param isFormField &lt;code&gt;true&lt;/code&gt; if this is a plain form field;<a name="line.190"></a>
<FONT color="green">191</FONT>         *                    &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.191"></a>
<FONT color="green">192</FONT>         * @param fileName    The name of the uploaded file, if any, as supplied<a name="line.192"></a>
<FONT color="green">193</FONT>         *                    by the browser or other client.<a name="line.193"></a>
<FONT color="green">194</FONT>         *<a name="line.194"></a>
<FONT color="green">195</FONT>         * @return The newly created file item.<a name="line.195"></a>
<FONT color="green">196</FONT>         */<a name="line.196"></a>
<FONT color="green">197</FONT>        public FileItem createItem(String fieldName, String contentType,<a name="line.197"></a>
<FONT color="green">198</FONT>                boolean isFormField, String fileName) {<a name="line.198"></a>
<FONT color="green">199</FONT>            DiskFileItem result = new DiskFileItem(fieldName, contentType,<a name="line.199"></a>
<FONT color="green">200</FONT>                    isFormField, fileName, sizeThreshold, repository);<a name="line.200"></a>
<FONT color="green">201</FONT>            FileCleaningTracker tracker = getFileCleaningTracker();<a name="line.201"></a>
<FONT color="green">202</FONT>            if (tracker != null) {<a name="line.202"></a>
<FONT color="green">203</FONT>                tracker.track(result.getTempFile(), this);<a name="line.203"></a>
<FONT color="green">204</FONT>            }<a name="line.204"></a>
<FONT color="green">205</FONT>            return result;<a name="line.205"></a>
<FONT color="green">206</FONT>        }<a name="line.206"></a>
<FONT color="green">207</FONT>    <a name="line.207"></a>
<FONT color="green">208</FONT>    <a name="line.208"></a>
<FONT color="green">209</FONT>        /**<a name="line.209"></a>
<FONT color="green">210</FONT>         * Returns the tracker, which is responsible for deleting temporary<a name="line.210"></a>
<FONT color="green">211</FONT>         * files.<a name="line.211"></a>
<FONT color="green">212</FONT>         * @return An instance of {@link FileCleaningTracker}, or null<a name="line.212"></a>
<FONT color="green">213</FONT>         *   (default), if temporary files aren't tracked.<a name="line.213"></a>
<FONT color="green">214</FONT>         */<a name="line.214"></a>
<FONT color="green">215</FONT>        public FileCleaningTracker getFileCleaningTracker() {<a name="line.215"></a>
<FONT color="green">216</FONT>            return fileCleaningTracker;<a name="line.216"></a>
<FONT color="green">217</FONT>        }<a name="line.217"></a>
<FONT color="green">218</FONT>    <a name="line.218"></a>
<FONT color="green">219</FONT>        /**<a name="line.219"></a>
<FONT color="green">220</FONT>         * Sets the tracker, which is responsible for deleting temporary<a name="line.220"></a>
<FONT color="green">221</FONT>         * files.<a name="line.221"></a>
<FONT color="green">222</FONT>         * @param pTracker An instance of {@link FileCleaningTracker},<a name="line.222"></a>
<FONT color="green">223</FONT>         *   which will from now on track the created files, or null<a name="line.223"></a>
<FONT color="green">224</FONT>         *   (default), to disable tracking.<a name="line.224"></a>
<FONT color="green">225</FONT>         */<a name="line.225"></a>
<FONT color="green">226</FONT>        public void setFileCleaningTracker(FileCleaningTracker pTracker) {<a name="line.226"></a>
<FONT color="green">227</FONT>            fileCleaningTracker = pTracker;<a name="line.227"></a>
<FONT color="green">228</FONT>        }<a name="line.228"></a>
<FONT color="green">229</FONT>    }<a name="line.229"></a>




























































</PRE>
</BODY>
</HTML>
